<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>bfpy.bfglobals</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="bfpy-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/bfpy/">BfPy</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="bfpy-module.html">Package&nbsp;bfpy</a> ::
        Module&nbsp;bfglobals
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="bfpy.bfglobals-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module bfglobals</h1><p class="nomargin-top"><span class="codelink"><a href="bfpy.bfglobals-pysrc.html">source&nbsp;code</a></span></p>
<p>BfPy global variables and functions module.</p>

<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Variables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">string</span>
    </td><td class="summary">
        <a name="libname"></a><span class="summary-name">libname</span> = <code title="'BfPy'"><code class="variable-quote">'</code><code class="variable-string">BfPy</code><code class="variable-quote">'</code></code><br />
      name of this library
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">float</span>
    </td><td class="summary">
        <a name="version"></a><span class="summary-name">version</span> = <code title="1.12">1.12</code><br />
      the version number of the library
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">string</span>
    </td><td class="summary">
        <a name="libstring"></a><span class="summary-name">libstring</span> = <code title="'BfPy 1.12'"><code class="variable-quote">'</code><code class="variable-string">BfPy 1.12</code><code class="variable-quote">'</code></code><br />
      the combined library name and version number
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">int</span>
    </td><td class="summary">
        <a name="freeApiId"></a><span class="summary-name">freeApiId</span> = <code title="82">82</code><br />
      default Betfair product Id, the one for the free API
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="Vendor"></a><span class="summary-name">Vendor</span> = <code title="-1">-1</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">int</span>
    </td><td class="summary">
        <a name="Global"></a><span class="summary-name">Global</span> = <code title="0">0</code><br />
      endPoint id (internal) for the Global Betfair endpoint service
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">int</span>
    </td><td class="summary">
        <a name="Exchange"></a><span class="summary-name">Exchange</span> = <code title="1">1</code><br />
      endPoint id (internal) to point out that a call goes to an Exchange
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">int</span>
    </td><td class="summary">
        <a name="ExchangeUK"></a><span class="summary-name">ExchangeUK</span> = <code title="1">1</code><br />
      endPoint id (Betfair) for the UK Exchange Betfair endpoint service
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">int</span>
    </td><td class="summary">
        <a name="ExchangeAus"></a><span class="summary-name">ExchangeAus</span> = <code title="2">2</code><br />
      endPoint id (Betfair) for the Aus Exchange Betfair endpoint service
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">list</span>
    </td><td class="summary">
        <a name="Exchanges"></a><span class="summary-name">Exchanges</span> = <code title="[1, 2]"><code class="variable-group">[</code>1<code class="variable-op">, </code>2<code class="variable-group">]</code></code><br />
      list of available Exchange endpoints
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">list</span>
    </td><td class="summary">
        <a name="EndPoints"></a><span class="summary-name">EndPoints</span> = <code title="[-1, 0, 1, 2]"><code class="variable-group">[</code>-1<code class="variable-op">, </code>0<code class="variable-op">, </code>1<code class="variable-op">, </code>2<code class="variable-group">]</code></code><br />
      list of available Betfair EndPoints
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">list</span>
    </td><td class="summary">
        <a href="bfpy.bfglobals-module.html#EndPointUrls" class="summary-name">EndPointUrls</a> = <code title="{-1: 'https://api.betfair.com/admin-api/v2/VendorService',
 0: 'https://api.betfair.com/global/v3/BFGlobalService',
 1: 'https://api.betfair.com/exchange/v5/BFExchangeService',
 2: 'https://api-au.betfair.com/exchange/v5/BFExchangeService'}"><code class="variable-group">{</code>-1<code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">https://api.betfair.com/admin-api/v2/Vend</code><code class="variable-ellipsis">...</code></code><br />
      list of available Betfair EndPoint Urls
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">dict</span>
    </td><td class="summary">
        <a href="bfpy.bfglobals-module.html#wsdlDefs" class="summary-name">wsdlDefs</a> = <code title="{-1: '''
&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;

&lt;!--

Copyright 2003-2004 The Sporting Exchange Limited. All rights reserved\
. 
The presentation, distribution or other dissemination of the informati\
..."><code class="variable-group">{</code>-1<code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">\n&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;\n\n&lt;</code><code class="variable-ellipsis">...</code></code><br />
      mapping of EndPoints to the WSDL contents
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">int</span>
    </td><td class="summary">
        <a name="eventRootId"></a><span class="summary-name">eventRootId</span> = <code title="-1">-1</code><br />
      default parentEventId to identify ActiveEventTypes in the joint call 
      that unifies GetActiveEventTypes and GetEvents
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">bool</span>
    </td><td class="summary">
        <a name="preProcess"></a><span class="summary-name">preProcess</span> = <code title="True">True</code><br />
      default library behaviour: process (easing use) the user requests 
      before sending them to Betfair
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">bool</span>
    </td><td class="summary">
        <a name="postProcess"></a><span class="summary-name">postProcess</span> = <code title="True">True</code><br />
      default library behaviour: process (easing use) Betfair answers 
      before sending them to Betfair
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">bool</span>
    </td><td class="summary">
        <a name="catchAllExceptions"></a><span class="summary-name">catchAllExceptions</span> = <code title="True">True</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">bool</span>
    </td><td class="summary">
        <a name="separateCounters"></a><span class="summary-name">separateCounters</span> = <code title="False">False</code><br />
      use separate counters (per exchange/endpoint) to throttle requests of
      calls that fall under the DataRequest (default: False)
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">bool</span>
    </td><td class="summary">
        <a href="bfpy.bfglobals-module.html#timeUtc" class="summary-name">timeUtc</a> = <code title="False">False</code><br />
      if True all DateTime objects received from Bf will be returned to the
      calling application as UTC and the library will assume that DateTime 
      objects passed by the application are in UTC
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">bool</span>
    </td><td class="summary">
        <a href="bfpy.bfglobals-module.html#timeUtcIn" class="summary-name">timeUtcIn</a> = <code title="False">False</code><br />
      if True all DateTime objects received from Bf will be returned to the
      calling application as UTC.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">bool</span>
    </td><td class="summary">
        <a href="bfpy.bfglobals-module.html#timeUtcOut" class="summary-name">timeUtcOut</a> = <code title="False">False</code><br />
      if True all DateTime objects passed by the application are in UTCr
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="timeConvertTimestamps"></a><span class="summary-name">timeConvertTimestamps</span> = <code title="True">True</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">bool</span>
    </td><td class="summary">
        <a href="bfpy.bfglobals-module.html#timeReturnAware" class="summary-name">timeReturnAware</a> = <code title="False">False</code><br />
      If True the DateTime objects returned to the application will have be
      be aware (have a timezone) representing the local timezone
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">bool</span>
    </td><td class="summary">
        <a href="bfpy.bfglobals-module.html#timeHonourAware" class="summary-name">timeHonourAware</a> = <code title="False">False</code><br />
      If True the DateTime objects passed by the application are expected 
      to be aware (have a timezone) representing the local timezone and 
      such local timezone will be used for the conversion to UTC before the
      value is sent to Betfair
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'bfpy'"><code class="variable-quote">'</code><code class="variable-string">bfpy</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="catchAllException"></a><span class="summary-name">catchAllException</span><br />
      catch and return as BfPythonError any possible error generated along 
      the library once a service has been called
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">bool</span>
    </td><td class="summary">
        <a href="bfpy.bfglobals-module.html#timeConvertTimestaps" class="summary-name">timeConvertTimestaps</a><br />
      Some of Bf DateTime values are returned as timestamps (in 
      millisecons) since the start of epoch (1st of January 1970).
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES DETAILS ==================== -->
<a name="section-VariablesDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-VariablesDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="EndPointUrls"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">EndPointUrls</h3>
  list of available Betfair EndPoint Urls
  <dl class="fields">
    <dt>Type:</dt>
      <dd>list</dd>
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
<code class="variable-group">{</code>-1<code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">https://api.betfair.com/admin-api/v2/VendorService</code><code class="variable-quote">'</code><code class="variable-op">,</code>
 0<code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">https://api.betfair.com/global/v3/BFGlobalService</code><code class="variable-quote">'</code><code class="variable-op">,</code>
 1<code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">https://api.betfair.com/exchange/v5/BFExchangeService</code><code class="variable-quote">'</code><code class="variable-op">,</code>
 2<code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">https://api-au.betfair.com/exchange/v5/BFExchangeService</code><code class="variable-quote">'</code><code class="variable-group">}</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="wsdlDefs"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">wsdlDefs</h3>
  mapping of EndPoints to the WSDL contents
  <dl class="fields">
    <dt>Type:</dt>
      <dd>dict</dd>
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
<code class="variable-group">{</code>-1<code class="variable-op">: </code><code class="variable-quote">'''</code><code class="variable-string"></code>
<code class="variable-string">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</code>
<code class="variable-string"></code>
<code class="variable-string">&lt;!--</code>
<code class="variable-string"></code>
<code class="variable-string">Copyright 2003-2004 The Sporting Exchange Limited. All rights reserved</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-string">. </code>
<code class="variable-string">The presentation, distribution or other dissemination of the informati</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="timeUtc"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">timeUtc</h3>
  if True all DateTime objects received from Bf will be returned to the 
  calling application as UTC and the library will assume that DateTime 
  objects passed by the application are in UTC
  <p>Default value: False</p>
  <dl class="fields">
    <dt>Type:</dt>
      <dd>bool</dd>
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
False
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="timeUtcIn"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">timeUtcIn</h3>
  if True all DateTime objects received from Bf will be returned to the 
  calling application as UTC.
  <p>Default value: False</p>
  <dl class="fields">
    <dt>Type:</dt>
      <dd>bool</dd>
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
False
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="timeUtcOut"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">timeUtcOut</h3>
  if True all DateTime objects passed by the application are in UTCr
  <p>Default value: False</p>
  <dl class="fields">
    <dt>Type:</dt>
      <dd>bool</dd>
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
False
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="timeReturnAware"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">timeReturnAware</h3>
  If True the DateTime objects returned to the application will have be be 
  aware (have a timezone) representing the local timezone
  <p>Default value: False</p>
  <dl class="fields">
    <dt>Type:</dt>
      <dd>bool</dd>
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
False
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="timeHonourAware"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">timeHonourAware</h3>
  If True the DateTime objects passed by the application are expected to be
  aware (have a timezone) representing the local timezone and such local 
  timezone will be used for the conversion to UTC before the value is sent 
  to Betfair
  <p>Default value: False</p>
  <dl class="fields">
    <dt>Type:</dt>
      <dd>bool</dd>
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
False
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="timeConvertTimestaps"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">timeConvertTimestaps</h3>
  Some of Bf DateTime values are returned as timestamps (in millisecons) 
  since the start of epoch (1st of January 1970). If true, these values 
  will be converted to DateTime objects
  <p>Default value: True</p>
  <dl class="fields">
    <dt>Type:</dt>
      <dd>bool</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="bfpy-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/bfpy/">BfPy</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Sat Jun 04 02:13:34 2011
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
